<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html version="4.01"><head><title>[retawq] Configuring Keymaps</title></head>
<body text="#000000" bgcolor="#cccccc" link="#0000ff" vlink="#551a8b"
alink="#551a8b" lang="en">
<center><b><font size="+2">retawq Documentation</font><br><font
size="+1">Configuring Keymaps</font></b></center>

<p>(This documentation file is only relevant in curses-like <a
href="runmode.html">runmode</a>.)</p>

<p><a name="intro"></a><b>Introduction</b></p>

<p>You can associate quite arbitrary keys with actual program actions,
overriding or complementing the <a href="key.html">default keys</a>. This
allows you to handle retawq e.g. similar to other browsers or your favorite
text editor.</p>

<p>This feature can be configured with the <a href="rtconfig.html">run-time
configuration option</a> "keymap", where each rule consists of one key
identifier and one action identifier, which are explained below.</p>

<p><a name="key"></a><b>Keys</b></p>

<p>Keys can be encoded as follows; please note that some of the "special" keys
don't work with all kinds of terminals.</p>

<ul>
<li>a single character (e.g. a letter or a digit) represents itself</li>
<li>"ctrl-" followed by a lowercase letter means that you keep the "Control"
modifier key down while pressing the letter key (example: "ctrl-w"); don't
customize "ctrl-c", "ctrl-m" or "ctrl-z" - that could cause problems or simply
won't work</li>
<li>"fn-" followed by a number in the range 0..63 means the respective function
key (example: "fn-1" for the function key with the label "F1"); function keys
aren't supported by all curses libraries; the value 0 seems to be rather
theoretical</li>
<li>the following identifiers are quite self-explanatory: "cursor-down",
"cursor-left", "cursor-right", "cursor-up", "delete", "end", "escape", "home",
"insert", "page-down", "page-up", "space", "tab"</li>
</ul>

<p><a name="cmd"></a><b>Commands</b></p>

<p>Command actions can be encoded as follows; for a more extensive description
of the actions, please refer to the "Commands" section of the <a
href="key.html">Keyboard Handling</a> documentation.</p>

<ul>
<!-- begin-autogenerated -->
<li>document-bottom: scroll down to the bottom of the current document (default
key: "end")</li>
<li>document-enforce-html: interpret the current document as HTML code (default
key: "H")</li>
<li>document-enforce-source: show the HTML source code of the current web page
(default key: "\")</li>
<li>document-info: show information about the current browser window view
(default key: "I")</li>
<li>document-reload: reload the current document without looking into retawq's
internal cache (default key: "r")</li>
<li>document-reload-enforced: like "document-reload", but additionally tries to
bypass <i>external</i> caches; it also tries again to lookup the hostname if
that failed previously (default key: "R")</li>
<li>document-save: save the current document in a file (default key: "s")</li>
<li>document-search: search for a string in the current document (default key:
"/")</li>
<li>document-search-backward: search backward for a string in the current
document (default key: "?")</li>
<li>document-search-next: search for the next occurrence of the string that was
entered earlier (no default key)</li>
<li>document-search-previous: search for the previous occurrence of the string
that was entered earlier (no default key)</li>
<li>document-top: scroll up to the top of the current document (default key:
"home")</li>
<li>download: download a document from a URL (default key: "ctrl-d")</li>
<li>download-from-element: download a document from the URL which is given by
the current link (default key: "D")</li>
<li>dump: dump the current document to a file (default key: "d")</li>
<li>element-enable: enable a disabled HTML form element (default key:
"E")</li>
<li>element-info: show information about the current link (or HTML form
element) (default key: "i")</li>
<li>element-next: go to the next link (or HTML form element) (default key:
"cursor-down")</li>
<li>element-open: open the current link in the current window, or activate the
current HTML form element (default keys: "return", "enter", "o")</li>
<li>element-open-split: like "window-new-from-element", but the screen is split
and the new window is shown in the other part of the screen (default key:
"ctrl-o")</li>
<li>element-previous: go to the previous link (or HTML form element) (default
key: "cursor-up")</li>
<li>execext-shell: execute a shell command (default key: "!")</li>
<li>execext-shell-flip: flip the shell command configuration (default key:
"&")</li>
<li>form-reset: reset the "current" HTML form (no default key)</li>
<li>form-submit: submit the "current" HTML form (no default key)</li>
<li>go-bookmarks: go to the bookmarks document URL (default key: "b")</li>
<li>go-home: go to the "home" URL (default key: "h")</li>
<li>go-search: go to your favorite search engine URL (default key: "e")</li>
<li>go-url: go to a new URL (default key: "g")</li>
<li>go-url-preset: like "go-url", but the new URL is preset to the URL of the
current document so you can edit it (default key: "G")</li>
<li>jump: "jump" to a URL (default key: "j")</li>
<li>jump-preset: like "jump", but the new jump shortcut is preset to the
previously entered shortcut so you can edit it (default key: "J")</li>
<li>line-down: scroll down one line in the current document (default keys: "l",
"delete")</li>
<li>line-up: scroll up one line in the current document (default keys: "L",
"insert")</li>
<li>local-file-dir-open: show a file selection dialog (in GTK <a
href="runmode.html">runmode</a>) (no default key)</li>
<li>menu-contextual: show the contextual menu (default key: "m")</li>
<li>menu-url-history: show the URL history (default key: "u")</li>
<li>menu-windowlist: show a list of all currently existing windows (default
key: "ctrl-w")</li>
<li>mouse-flip: turn the mouse on/off (flip its current state) (default key:
"Y")</li>
<li>mouse-off: turn the mouse off (no default key)</li>
<li>mouse-on: turn the mouse on (no default key)</li>
<li>page-down: scroll down one screenfull of lines in the current document
(default keys: "page-down", "space")</li>
<li>page-up: scroll up one screenfull of lines in the current document (default
key: "page-up")</li>
<li>quit: quit retawq (default key: "Q")</li>
<li>screen-split: split the screen (default key: "2")</li>
<li>screen-switch: switch between visible windows when the screen is split
(default key: "tab")</li>
<li>screen-unsplit: un-split the screen (default key: "1")</li>
<li>scroll-bars-flip: turn the scroll bars on/off (flip their current state);
currently this is only relevant if the <a href="ctconfig.html">compile-time
configuration option</a> OPTION_TG has been set to xcurses; scroll bars are
"expensive" because the whole HTML document has to be rendered internally to
find out how many lines it contains; such full rendering is usually only done
if you actually scroll down to the bottom of a document; so, when you want to
load a very long HTML document (e.g. 500 KB) on a slow computer, you might want
to disable scroll bars in advance (no default key)</li>
<li>session-resume: resume a <a href="session.html">session</a> from a file
(default key: "M")</li>
<li>session-save: save the current <a href="session.html">session</a> in a file
(default key: "S")</li>
<li>stop: stop any ongoing network/disk activity for the current document
(default key: ".")</li>
<li>view-back: go back to the previous document in the series of documents in
the current window (default key: "cursor-left")</li>
<li>view-forward: go to the next document in the series of documents in the
current window (default key: "cursor-right")</li>
<li>window-close: close the current window (default key: "C")</li>
<li>window-new: create a new "virtual window" (default key: "n")</li>
<li>window-new-from-document: open the current document in a new window
(default key: "N")</li>
<li>window-new-from-element: open the current link in a new window (default
key: "O")</li>
<li>window-next: go to the next virtual window in the list of all virtual
windows (default key: "w")</li>
<li>window-previous: go to the previous virtual window in the list of all
virtual windows (default key: "W")</li>
<!-- end-autogenerated -->
</ul>

<p><a name="lineinput"></a><b>Line Input</b></p>

<p>Actions for the line input mode can be encoded as follows; you shouldn't map
self-representing keys (e.g. letters) to actions because then you wouldn't be
able to enter them as text in the edit area. For a more extensive description
of the actions, please refer to the "Line Input" section of the <a
href="key.html">Keyboard Handling</a> documentation.</p>

<ul>
<!-- begin-autogenerated -->
<li>area-switch: switch between message area and edit area (default key:
"ctrl-a")</li>
<li>cancel: cancel the current line input operation; if it takes a "long" time
until you get the effect of the usual escape key, associate a different key
with this action... (default key: "escape")</li>
<li>mouse-flip: turn the mouse on/off (flip its current state) (no default
key)</li>
<li>mouse-off: turn the mouse off (no default key)</li>
<li>mouse-on: turn the mouse on (no default key)</li>
<li>pass2user: go back from entering a login password to entering a login
username (default key: "ctrl-u")</li>
<li>to-end: move the cursor to the end of the text (default keys:
"cursor-down", "page-down", "end")</li>
<li>to-left: move the cursor one position to the left (default key:
"cursor-left")</li>
<li>to-right: move the cursor one position to the right (default key:
"cursor-right")</li>
<li>to-start: move the cursor to the start of the text (default keys:
"cursor-up", "page-up", "home")</li>
<!-- end-autogenerated -->
</ul>

<p><hr>This documentation file is part of version 0.2.6c of <a
href="http://retawq.sourceforge.net/">retawq</a>, a network client created by
<span lang="de">Arne Thoma&szlig;en</span>. retawq is basically released under
certain versions of the GNU General Public License and WITHOUT ANY WARRANTY.
Copyright (C) 2001-2006 <a href="mailto:arne@arne-thomassen.de"><span
lang="de">Arne Thoma&szlig;en</span></a>.</p>
</body></html>
